Copyright: CreateHelp! {Registered} ® Nic Barnes 1993


Table of Contents

Overview

Installation

Getting Started

Setup Options

The Toolbar

The Menus

The HPJ File

Obtaining the Tools

The Shareware Concept

Disclaimer

Shareware Agreement

Copyright

Registration

Contacting the Author

Registration Form


Overview

Having developed a few in-house windows applications I found the need to write associated help files. Writing these is nothing short of a pain, so I looked around for third party solutions to simplify this process and found none suitable,  hence CreateHelp! was written.

CreateHelp! automates all the laborious cross referencing of hypertext jumps and allows for easy conversion of a 'text' document to a hypertext document.

To write HLP files you need a rich text formatted document that uses special footnote references to identify each topic or 'page' and hidden text to reference hypertext jumps and pop-ups (definitions).

The special footnotes and character formatting used are as follows:

footnote	#	Context string

footnote	$	Title

footnote	+	Browse Sequence no.

footnote	K	Keyword

Double Underlined Text

Single Underlined Text

Hidden Text

CreateHelp! allows for all this information to be entered into dialog boxes that then automatically formats the text appropriately and references the necessary jumps etc.

This is done using two WinWord documents, the first is the main body of the HLP file and has the standard DOC extension and the second contains all the definition context IDs that are use for the pop-ups, this has the extension DFN.  At compilation time these two files are saved as rich text format documents with the extensions RTF and DEF respectively.

The final file created and maintained by CreateHelp!  is the HPJ file. This is a text file, similar to an INI file, which is used by the help compiler - HCxx to determine all the compilation options etc.


Installation

The archive CHxxx.ZIP should contain the following files:

C_HELP!.DOT	MANUAL.DOC
C_HELP!.HLP	README.TXT

C_HELP!.DOT should be unpacked into your WinWord directory, or the directory in which your templates are stored, C_HELP!.HLP can be placed in either your Windows or WinWord directory.  MANUAL.DOC and README.TXT can be anywhere you wish, but you are strongly advised to take a peek at README.TXT as it contains the last minute release notes.


Getting Started

To setup CreateHelp! for the first time: From WinWord select FILE NEW then the template C_HELP! which should appear in your list of available templates (if not see Installation).  You are then prompted for the setup options which determine the location of all the project files etc.

On starting any new project (i.e. by FILE NEW, C_HELP!) you  are asked for a project name, and your first project is no exception.  The project name must be a DOS standard file name with no extension.  CreateHelp! gives all the project files the same name with their own various extensions

That's it you ready to start writing your first help file.

Select INSERT NEW CONTEXT from the menus or [image] from the toolbar.  You are presented with a dialog box prompting you for a Title, Context ID, Browse Sequence Number and associated Keywords with options of Auto Context, Auto Insert Title and Use Title as Keyword.

Having completed this dialog box the footnotes are then inserted and you are returned to the main editing window of your document.  You will then be asked if this is the contents page, this sets the CONTENTS section of the HPJ file.  If you answer NO you will be asked again after every new context ID until the contents page is defined.

That's basically it!  The sections The Toolbar and The Menus will explain further all the features available with CreateHelp!

See Also: The HPJ File


Setup Options

The following options must be set:

Project Path

Graphics Path

Help Compiler

Compiler Path

SHED Installed

SHED Path

Title Font

Body Text

Definition Titles

Definition Body


The ToolBar

Click on any button for a brief definition or click on its name for a full description

Insert New Context

Insert Title

Insert Browse Sequence

Insert Keyword

Insert Definition

Insert Jump

Insert Picture

Launch SHED

Tools Spelling

Launch Help

Compile Help


The Menus

The menus that are changed or added in CreateHelp! are as follows:

File Close project

Edit Find & Insert Jump or Def

Edit HPJ File

View Errorlog

Insert Picture

Insert New Context

Insert Title

Insert Browse Sequence

Insert Keyword

Insert Jump

Insert Definition

Tools Launch Help

Tools Compile Help

Tools Launch SHED

Tools Setup CreateHelp!

Help CreateHelp! Index

Help About

Help Register


The HPJ File

The HPJ file is the project file specifying as the compilation options.  Those that are directly editable from within CreateHelp! are as follows:

ROOT

BMROOT

ERRORLOG

TITLE

CONTENTS

ICON

WARNING

REPORT

COMPRESS


Obtaining the Tools

The files HCxx and SHED.EXE are included with the Windows SDK, Visual Basic Professional Edition (versions 1.0 and 2.0) and probably in a few other SDKs.  However those of you that don't have these products needn't dismay.

Both files are available from library 16 in the WINSDK forum on Compuserv.

At time of writing the most recent versions were:

HCP.ZIP 11 01/93

SHED.ZIP 10 01/93


Registration

This product is Shareware and its continued development can only be supported by YOU!  This license allows you to use this software for evaluation purposes without charge for a period of 30 days.  If you use this software after the 30 day evaluation period a registration fee is required. One registered copy of CreateHelp! may be used by a single person who uses the software on one or more computers or to a single workstation used by multiple people.

If you continue to use this product after a reasonable trial period then please register it.


Shareware Agreement

You are hereby licensed to:  Use this software for a 30 day evaluation period; make as many copies of this software and documentation as you wish; give exact copies of the original to anyone; and distribute the software and documentation in its unmodified form via electronic means.  There is no charge for any of the above.

You are specifically prohibited from charging, or requesting donations, for any such copies, however made; and from distributing the software and/or documentation with other products (commercial or otherwise) without prior written permission.


Contacting the Author

By eMail @ Compuserv 100111,3452

By Snail Mail @ Nic Barnes, CHC, 27 West Park, London SE9 4RZ, ENGLAND


Copyright

These programs and the related documentation are copyright. The sole owner is Nic Barnes. All rights reserved. You may not use, copy, modify, or transfer the programs, documentation, or any copy except as expressly provided in the shareware agreement.

© Copyright Nic Barnes 1993.


Disclaimer

This product is provided "as is" without representation of warranty, either expressed or implied.

The entire risk as to the use of this product is assumed by the user.  In no event will Nic Barnes or his estate be liable for any damages direct, indirect, incidental or consequential resulting from any defect in the product.

If you do not accept these terms you must cease using this product forthwith and destroy the program, the documentation and all copies thereof.


The Shareware Concept

Shareware is copyrighted software that is distributed by authors through bulletin boards, on-line services and disk vendors.

Shareware allows you to try the software for a reasonable limited period.  If you decide not to continue using it, you throw it away and forget about it. You only pay for it if you continue to use it. Shareware is a distribution method, not a type of software. You benefit because you get to use the software to determine whether it meets your needs, before you pay for it.

The shareware system and the continued availability of quality shareware products depend on your willingness to register and pay for the shareware you use. It's the registration fees you pay which allow authors to support and continue to develop our products. Please show your support for shareware by registering those programs you actually use.


Registration Form

I have found CreateHelp! useful and wish to continue to use it.

I enclose payment of  UK£20.00 / US$40.00* made payable to Nic Barnes

*delete as applicable

Name:	____________________________________
Title:	____________________________________
Company:	____________________________________
Address:	____________________________________
	____________________________________
City, State	____________________________________
Zip/Post Code	____________________________________
Country	____________________________________
eMail address	____________________________________
Where did you obtain this product from?	________________
Please send to:	Nic Barnes

CHC

27 West Park

London SE9 4RZ

ENGLAND


File Close
File Close project

This closes the current file (prompting you to save changes) then tests whether other project files are open then proceeds to close them all (again prompting you to save changes)


Edit Find & Insert Jump or Def

This performs a case sensitive text search then prompts for a Jump or Definition reference.  Once the reference has been made the search repeats.  This is useful for defining multiple occurrences of a certain phrase


Insert Picture

As per regular Insert Picture however after file selection options are given to insert as a bitmap or opaque referenced picture.  Selecting the latter allows for the insertion of hypergraphics and makes for a smaller HLP file size


Insert New Context

This is creates a new context section.  At the same time the title, browse sequence and keywords may be entered for the given context

Auto Insert Title:

Inserts the title text into the document in the Title Text font

Auto Insert Context:

Creates a context ID based on the first two words of the title separated by an underline.  This is useful for shorter HLP files however it may cause duplicated titles in longer HLP files.  If this is not checked a context ID must be entered - no spaces!

Use Title as Keyword:

Add the Title to the list of Keywords.

See Also:

Insert Title

Insert Browse Sequence

Insert Keyword


Insert Title

This inserts the title name into the current context.  This is not necessary if the it was entered with Insert New Context


Insert Browse Sequence

This inserts the browse sequence number into the current context.  This is not necessary if it was entered with Insert New Context


Insert Keyword

This inserts the keywords into the current context.  This is not necessary if they were entered with Insert New Context


Insert Jump

Prompts for a context to associate the selected text with.

This searches for all available contexts.  It can be slow especially on slower machines or large DOC files.  Use this if you need to find the name of a forgotten context.


Insert Definition

Inserts a definition for the selected text in the DFN file.  Guesses the context name or allows for a search of all available contexts

This searches for all available contexts.  It can be slow especially on slower machines or large DFN files.  Use this if you need to find the name of a forgotten context.


Tools Launch Help

Launches the HLP files associated with the current project.  This will generate an error unless the project has been compiled or if the file has been re-compiled since last loaded by WinHelp


Tools Compile Help

Launches HCxx with the current project's HPJ.  As this is a shell out to DOS you may require a PIF file for HCxx

On returning to WinWord you are given the options to load the error file generated by HCxx and/or to launch the newly compiled HLP file


Tools Setup CreateHelp!

Runs through all the setup options for CreateHelp!

See Setup Options


Help CreateHelp! Index

Launches the CreateHelp! HLP file (you already made it here)


Help About

Shows the About dialog box, including registration status, version number etc.


Help Register

Allows the entry of registration details to remove the nag messages

See Also:

Registration


View Errorlog

Opens the Errorlog as defined in the ERRORLOG section of the HPJ file

Generates an error unless the file has been compiled


Launch SHED

Launches the MS Hypergraphics editor (if installed)


CreateHelp! - © Nic Barnes 1993


Context string - A name (containing no spaces) which uniquely identifies the 'page', allowing for hypertext jumps and definitions


Title - A title for the 'page'


Browse Sequence no. - Sets the order in which 'pages' are viewed when using the << and >> buttons


Keyword - Sets the keywords that are listed in the search dialog box (when the Show Topics button is pressed the titles of related 'pages' are shown)


Double Underlined Text - Indicates a 'page' that can be jumped to


Single Underlined Text - Indicates a definition or pop-up (you're looking at one)


Hidden Text - The context ID of a 'page' that is to be referenced by a definition or jump


CHxxx.ZIP - where xxx refers to the version number.  This is the distribution archive for all the CreateHelp! files.


C_HELP!.DOT - the CreateHelp! template


C_HELP!.HLP - the CreateHelp! help file (you're looking at it)


C_HELP!.INI - the CreateHelp! initialisation file (stored in your windows directory)


README.TXT - last minute release notes etc.


MANUAL.DOC - the CreateHelp! instruction manual


*.DFN - the definition file containing all the definition (pop-up) context IDs in WinWord format.  This is saved as *.DEF (in Rich Text Format) by the compilation routine


*.DOC - the main body of the help file in WinWord format.  This is saved as *.RTF (in Rich Text Format) by the compilation routine


*.HPJ - the project file in DOS text format and is used by the compiler HCxx to reference all the compilation options and included files etc.
See Also: The HPJ File


*.HLP - these are the help format files used by WinHelp


*.RTF - the DOC file is saved as this (in Rich Text Format) by the compilation routine


*.DEF - the DFN file is saved as this (in Rich Text Format) by the compilation routine


Rich Text Format - the format required by HCxx for compilation


HCxx - the help compiler; HC30.EXE, HC31.EXE or HCP.EXE

See Also: Obtaining the tools


Title Font - this is the font used in INSERT NEW CONTEXT if Auto Insert Title is on. (as per Setup Options) - Only supports font, points, bold, italic and color


Body Text - the font used for the main body of the file (as per The following options...) - Only supports font, points, bold, italic and color


Definition Titles - the font used for the definition title when using INSERT DEFINITION (as per Definition Titles) - Only supports font, points, bold, italic and color


Definition Body - the font used for the definition text when using INSERT DEFINITION (as per 'the font used...') - Only supports font, points, bold, italic and color


Auto Context - will automatically set a context ID based on the first two words of the Title (thus Table of Contents would become TABLE_OF).


Auto Insert Title - will insert the Title into the document using the Title Font set in setup options.


Use Title as Keyword - will add the Title to the list of Keywords.


Project Path - is where all the project files are stored; DOC, DFN, HPJ and RTF & DEF


Graphics Path - sets the BMROOT option in the HPJ file.  It is where most of your graphics files are stored, if they are not then INSERT PICTURE, Referenced Picture will insert the full path to the graphic.


Help Compiler - gives you the choice of using HC30, HC31 or HCP

See Also: Obtaining the tools


Compiler Path - the path where HCxx resides


SHED Installed - YES/NO as to whether SHED.EXE is installed


SHED Path - the path to SHED.EXE


ROOT - the location of the DEF and RTF files. Beware of changing this, its better to change it via Setup Options


BMROOT - the location of the graphics files


ERRORLOG - the error file that HCxx writes after compilation


TITLE - what is displayed in the WinHelp title bar when the HLP file is run


CONTENTS - the Context ID of the contents page.  It is jumped to when the WinHelp CONTENTS button is pressed


ICON - defines the ICO format icon for your HLP file.  This must include the full path


WARNING - 1, 2 or 3 - the warning level that HCxx generates


REPORT - ON or OFF, whether or not HCxx reports errors


COMPRESS - this option causes HCxx to compress the HLP file but can slow the compression process down considerably. Leave this set to OFF until the HLP file is debugged and then re-compile using the HIGH option


CHxxx.ZIP - where xxx refers to the version number.  This is the distribution archive for all the CreateHelp! files.


C_HELP!.DOT - the CreateHelp! template


C_HELP!.HLP - the CreateHelp! help file (you're looking at it)


README.TXT - last minute release notes etc.


MANUAL.DOC - the CreateHelp! instruction manual


Insert New Context - this inserts a page beak followed by footnote references for context ID, title, browse sequence and keywords, though all that is required is context ID


Insert Title - inserts a footnote reference for the context's title. (The cursor can be anywhere in the section) This is unnecessary if the title has been filled in with Insert New Context


Insert Browse Sequence - inserts a footnote reference for the context's browse sequence. (The cursor can be anywhere in the section) This is unnecessary if the browse sequence has been filled in with Insert New Context


Insert Keyword - inserts a footnote reference for the context's keywords. (The cursor can be anywhere in the section) This is unnecessary if the keywords have been filled in with Insert New Context


Insert Definition - this enables a definition to be entered into the DFN file and referenced to the selected text.  Text must be selected for this to work


Insert Jump - this enables a jump to be referenced to the selected text.  Text must be selected for this to work


Insert Picture - similar to the Insert Picture normally found in WinWord, however after selecting the file you have the option to insert as a bitmap or a referenced picture


Launch SHED - launches the Microsoft Hypergraphics editor  - SHED.EXE (if installed)


Tools Spelling - not come across this one before eh?


Launch Help - launches the help file associated with the current project (NOT this file) Generates an error unless the current project has been compiled


Compile Help - uses HCxx to compile your current project into a HLP file


SHED.EXE - the MS Hypergraphics editor.

See Also: Obtaining the tools


WinHelp - the Microsoft Windows Help engine - this is required to view HLP files